/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Nesta anotação estão definidas as propriedades para um campo do painel.
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FieldDefinition {

    /**
     * Representa os nomes para construção do painel.
     * @return Retorna um array de nomes para esta definição de um painel.
     */
    public String[] alias() default "";

    /**
     * Rótulo do campo no painel.
     * @return Retorna o rótulo do campo.
     */
    public String label();

    /**
     * Rótulo informativo para o campo.
     * @return retorna o rótulo informativo.
     */
    public String infoLabel() default "";

    /**
     * Indice do campo no painel.
     * @return Retorna o indice do campo no painel.
     */
    public int index() default 0;

    /**
     * Indica se o campo deve ser mostrado na linha abaixo do campo anterior.
     * @return Retorna se o campo deve ser mostrado na linha abaixo do campo
     * anterior.
     */
    public boolean jumpNextRow() default true;

    /**
     * Indica se o campo é sómente para leitura.
     * @return Retorna se o campo é sómente para leitura.
     */
    public boolean readOnly() default false;

    /**
     * Alinhamento do campo. Referente a Representação visual do componente
     * de entrada de dados.
     * Descrição e Valores Validos:<br>
     * LEADING  = 0<br>
     * TRAILING = 1<br>
     * CENTER   = 2<br>
     * BASELINE = 3<br>
     * Constantes na interface FieldComponent.
     * 
     * @see org.balisunrise.common.FieldComponent
     */
    public int alignment() default 0;

    /**
     * Propriedades adicionais para a definição.
     */
    public Property[] properties() default {};
}
